Event Handler Registration

Event handlers are used with expiration and enrollmentClosed Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). (pending, issued and denied certificate requests) alerts to trigger additional automated tasks at the time the alerts are run. Keyfactor Command workflows (see Workflow Definitions) do not use event handlers.

Tip:  Where to find this in the Management Portal:
System Settings → Event Handler Registration

Keyfactor provides several event handlers out of the box:

Log events to the Keyfactor Command server Windows event log (or other machine event log) for each expiration alert when the alert task is triggered.

Run a PowerShell script on the Keyfactor Command server for each expiration alert when the alert task is triggered.

Execute a certificate renewal for each expiring certificate that is found in a supported certificate store for each expiration alert when the alert task is triggered.

Log events to the Keyfactor Command server Windows event log (or other machine event log) for each pending request alert when the alert task is triggered.

Run a PowerShell script on the Keyfactor Command server for each pending request alert when the alert task is triggered.

Log events to the Keyfactor Command server Windows event log (or other machine event log) for each issued certificate alert when the alert task is triggered.

Run a PowerShell script on the Keyfactor Command server for each issued certificate alert when the alert task is triggered.

Log events to the Keyfactor Command server Windows event log (or other machine event log) for each denied request alert when the alert task is triggered.

Run a PowerShell script on the Keyfactor Command server for each denied request alert when the alert task is triggered.

Log events to the Keyfactor Command server Windows event log (or other machine event log) for each SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. key rotation alert when the alert task is triggered.

Run a PowerShell script on the Keyfactor Command server for each SSH key rotation alert when the alert task is triggered.

For information on using built-in event handlers, see Using Event Handlers.

Tip:  Click the help icon () next to the Event Handler Registration page title to open the Keyfactor Software & Documentation Portal to this section. You will receive a prompt indicating:

You are being redirected to an external website ‘software.keyfactor.com'. Would you like to proceed?

You can also find Help in the NavigatorClosed The Navigator is the Keyfactor Command left-hand (newer versions) or top (older versions) navigation menu. Certificate collections and reports can be configured to be added to the menu using user-defined Show in Navigator settings.. From here you can choose to open either the Keyfactor Software & Documentation Portal at the home page or the Keyfactor API Endpoint Utility.

Keyfactor provides two sets of documentation: the On-Premises Documentation Suite and the Managed Services Documentation Suite. Which documentation set is accessed is determined by the Application Settings: On-Prem Documentation setting (see Application Settings: Console Tab).